home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 16 / CU Amiga Magazine's Super CD-ROM 16 (1997-10-16)(EMAP Images)(GB)[!][issue 1997-11].iso / CUCD / Online / HBBS / Docs / DirsList < prev    next >
Text File  |  1997-08-22  |  17KB  |  515 lines

  1.  
  2. HBBS:
  3. |
  4. +-@{"BBSGlobal" link HBBS:Docs/Configuration/BBSGlobal.guide/MAIN}                        Main System configuration file
  5. |
  6. +-Docs
  7. | |
  8. | +-<.guide files>                 Documentation for HBBS
  9. | |
  10. | +-Doors
  11. |   |
  12. |   +-Doors.Guide                  Index to all Door documentation
  13. |   |
  14. |   +-<doorname>.guide
  15. |
  16. +-Nodes
  17. | |
  18. | +-@{"NodeList" link HBBS:Docs/Configuration/NodeList.guide/MAIN}                       Details of nodes
  19. | |
  20. | +-@{"NodeGlobal" link HBBS:Docs/Configuration/NodeGlobal.guide/MAIN}                     Each nodes settings default to the settings
  21. | |                                in the file and then are overridden by the ones
  22. | |                                in the node's @{"NodeLocal" link HBBS:Docs/Configuration/NodeLocal.guide/MAIN} file
  23. | |
  24. | +-@{"Node<NodeNum>" link NodeX}                  (location must be as specified in @{"NodeList" link HBBS:Docs/Configuration/NodeList.guide/MAIN})
  25. |   |
  26. |   +-@{"NodeLocal" link HBBS:Docs/Configuration/NodeLocal.guide/MAIN}                    Settings for the node
  27. |   |
  28. |   +-@{"Device" link HBBS:Docs/Configuration/Device.Guide/MAIN}                       Serial/Modem settings details
  29. |   |
  30. |   +-BBSColours.CFG               Ansi menu and prompt colors config file
  31. |   |
  32. |   +-BBSStrings.CFG               Custom Prompt/Message config file
  33. |   |
  34. |   +-Logs
  35. |   | |
  36. |   | +-Callers.log                Callers log file for node
  37. |   | |                            (location can be changed via @{"NodeLocal" link HBBS:Docs/Configuration/NodeLocal.guide/MAIN})
  38. |   | |
  39. |   | +-Node.log                   Node log file for node
  40. |   |                              (location can be changed via @{"NodeLocal" link HBBS:Docs/Configuration/NodeLocal.guide/MAIN})
  41. |   |
  42. |   +-@{"PlayPen" Link PlayPenDir}                      Files uploaded to the bbs go here.
  43. |   | |                            (location can be changed via @{"NodeLocal" link HBBS:Docs/Configuration/NodeLocal.guide/MAIN})
  44. |   | |
  45. |   | +-<Uploaded file go here>
  46. |   |
  47. |   +-@{"Work" Link WorkDir}                         Temporary Files go in this directory.
  48. |   | |                            LOCATION CANNOT BE CHANGED
  49. |   | |
  50. |   | +-<Temporary files go here>
  51. |   |
  52. |   +-Storage
  53. |   | |                            Place unused configs etc in here if you want
  54. |   | +-<Misc sysop files>
  55. |   |
  56. |   +-Access
  57. |   | |
  58. |   | +-Level_<ACS>                Node access settings files
  59. |   |
  60. |   +-Commands
  61. |   | |
  62. |   | +-System                     System commands
  63. |   | |
  64. |   | +-Level_Global               Commands for all users
  65. |   | |
  66. |   | +-Level_<ACS>                Commands for users with this access level.
  67. |   |                              overrides settings in Level_Global
  68. |   |
  69. |   +-Screens
  70. |     |
  71. |     +-Special
  72. |     | |
  73. |     | +-<ScreenFiles>            Special Screen Files go in here.
  74. |     |                            Files in here override those in
  75. |     |                            HBBS:Screens/Special
  76. |     +-Storage
  77. |       |
  78. |       +-<Misc Sysop screens>     Place unused node related screens here.
  79. |
  80. +-@{"Doors" link HBBS:Docs/Doors/DOORIndex.guide/MAIN}
  81. | |
  82. | +-System
  83. | | |
  84. | | +-Node                         The NODE executable itself
  85. | | |
  86. | | +-Storage
  87. | | | |
  88. | | | +-<Misc door directories>    Place old/unused door directories here.
  89. | | |
  90. | | +-<Door Directory>
  91. | |   |
  92. | |   +-<Door Executable>
  93. | |   |
  94. | |   +-<Door configs>
  95. | |   |
  96. | |   +-<Door data files>
  97. | |
  98. | +-User
  99. |   |
  100. |   +-Storage
  101. |   | |
  102. |   | +-<Misc door directories>    Place old/unused door directories here.
  103. |   |
  104. |   +-<Door Directory>
  105. |     |
  106. |     +-<Door Executable>
  107. |     |
  108. |     +-<Door configs>
  109. |     |
  110. |     +-<Door data files>
  111. |
  112. +-Commands
  113. | |
  114. | +-System                         System commands
  115. | |
  116. | +-Level_Global                   Commands for all users
  117. | |
  118. | +-Level_<ACS>                    Commands for users with this access level.
  119. |
  120. +-@{"Conferences" link Conferences}
  121. | |
  122. | +-ConfList                       List of all conferences
  123. | |
  124. | +-<ConfName>                     As specified in ConfList
  125. |   |
  126. |   +-ConfConfig                   Conference Settings details
  127. |   |
  128. |   +-BBSColours.CFG               Ansi menu and prompt colors config file
  129. |   |
  130. |   +-BBSStrings.CFG               Custom Prompt/Message config file
  131. |   |
  132. |   +-BadFiles                     (Location can be changed via ConfConfig)
  133. |   | |
  134. |   | +-<Bad Files>                Uploads to this conf that are corrupt
  135. |   |
  136. |   +-Hold                         (Location can be changed via ConfConfig)
  137. |   | |
  138. |   | +-<Sysop Help Files>         Uploads for the sysop.
  139. |   |
  140. |   +-LostFiles
  141. |   | |
  142. |   | +-<Lost files go here>       If a file could not be moved etc it may
  143. |   |                              be found in here.  Check logs for matching
  144. |   |                              filenames to find out why it is in here.
  145. |   |
  146. |   +-PartUpload
  147. |   | |
  148. |   | +-<PartUpload>@<UserID>      If a file is canceled or carrier lost
  149. |   |                              during transfer it is kept here and the
  150. |   |                              users' id is added to the filename
  151. |   |
  152. |   +-Screens                      Conference related ansi/ascii screens
  153. |   | |
  154. |   | +-Special
  155. |   |   |
  156. |   |   +-<ScreenFiles>            Screens in here override those in
  157. |   |                              <NodeLocation>/Screens/Special
  158. |   |
  159. |   +-Access
  160. |   | |
  161. |   | +-Level_<ACS>                Conference access settings files
  162. |   |
  163. |   +-FileLists
  164. |   | |
  165. |   | +-<FileList>                 (Location may be changed via ConfConfig)
  166. |   |
  167. |   +-Mail
  168. |   | |
  169. |   | +-<Mail Files>               See the current mail system docs for details
  170. |   |
  171. |   +-Commands
  172. |     |
  173. |     +-System                     System commands
  174. |     |
  175. |     +-Level_Global               Commands for all users
  176. |     |
  177. |     +-Level_<ACS>                Commands for users with this access level.
  178. |
  179. +-Access
  180. | |
  181. | +-Levels
  182. | | |
  183. | | +-Level_List                   List of access levels
  184. | | |
  185. | | +-Level_Global                 Global access settings
  186. | | |
  187. | | +-Level_<ACS>                  BBS access settings files
  188. | |
  189. | +-@{"Users" link ACSUsersDir}
  190. |   |
  191. |   +-<UserHandle>                 User access settings files
  192. |                                  If you have a file with the same name as
  193. |                                  the users handle it will override all the
  194. |                                  conference, node and system access ettings
  195. |
  196. +-System
  197. | |
  198. | +-Protocols                      Transfer protocol definitions
  199. | |
  200. | +-FCheck                         Config for checking/testing uploaded files
  201. | |
  202. | +-@{"FileID" Link HBBS:Docs/Configuration/FileID.Guide/MAIN}                         Config for adding/extracting file_id.diz's
  203. | |
  204. | +-Amiga
  205. | | |
  206. | | +-CLI
  207. | | |
  208. | | +-Libs                         This is added to you libs: assign
  209. | | | |                            so you can put HBBS and it's utilities'
  210. | | | |                            shared amiga .library files in here
  211. | | | +-<Amiga .library files>
  212. | | | |
  213. | | | +-HBBSCommon.library
  214. | | | |
  215. | | | +-HBBSNode.library
  216. | | | |
  217. | | | +-xpr
  218. | | |   |
  219. | | |   +-<unused xpr library>     Unused xpr#?.library files
  220. | | |
  221. | | +-Fonts                        This is added to the Fonts: assign so you
  222. | | | |                            can place all hbbs and related fonts here
  223. | | | |-<Font files and dirs>
  224. | | | |
  225. | | | +-HBBS.font
  226. | | | |
  227. | | | +-HBBS
  228. | | | | |
  229. | | | | +-8
  230. | | | |
  231. | | | +-HBBS_IBM.font
  232. | | | |
  233. | | | +-HBBS_IBM
  234. | | |   |
  235. | | |   +-8
  236. | | +-Devs                         This is added to the Devs: assign so you
  237. | |   |                            can place all hbbs and related devices here
  238. | |   +-<Amiga .device files>
  239. | |
  240. | +-Data
  241. |   |
  242. |   +-BBSColours.CFG               Ansi menu and prompt colors config file
  243. |   |
  244. |   +-BBSStrings.CFG               Custom Prompt/Message config file
  245. |   |
  246. |   +-Calls.CFG                    Created by the system, resets at first user
  247. |   |                              login after midnight
  248. |   |
  249. |   +-PrivateData                  Created by the system, NEVER EDIT THIS!
  250. |   |
  251. |   +-user.data                    User data file
  252. |   |                              (Location may be changed via BBSGlobal)
  253. |   |
  254. |   +-CtrlScrPrefs.CFG             Screenmode prefs file, created by the system
  255. |   |
  256. |   +-Users
  257. |   | |
  258. |   | +-<UserID>                   Each user has their own special directory
  259. |   |   |                          into which door codes can save users
  260. |   |   |                          personal preferences in.
  261. |   |   |
  262. |   |   |                          Note: each <UserID> directory's comment it
  263. |   |   |                          set to the users handle.  Try using "C:List"
  264. |   |   +-<Config Files>
  265. |   |   |
  266. |   |   +-TaggedFiles.CFG          Created by the system.
  267. |   |                              If you trash your upload download dirs it
  268. |   |                              might be an idea to remove all these..
  269. |   +-ConfAcs
  270. |     |
  271. |     +-<AccessName>.CFG           Filename defined in Level_List
  272. |                                  These files determine what confs the users
  273. |                                  can join or see.
  274. |                                  You can set individual users confacs files
  275. |                                  for each user.
  276. |
  277. +-Utils
  278. | |
  279. | +-<Utilitiy files>               See elsewhere for a list of supplied utils.
  280. |
  281. +-Screens
  282. | |
  283. | +-Special                        System related ansi/ascii screens
  284. | | |
  285. | | +-<ScreenFiles>                See screens.guide
  286. | |
  287. | +-Storage
  288. |   |
  289. |   +-<ScreenFiles>                Unused screen files
  290. |
  291. +-Storage
  292. | |
  293. | +-<Misc sysop files>
  294. |
  295. +-Scripts                          Script files
  296. | |
  297. | +-Logoff_Global.script           Always called even if LogOff<NodeNum>.script exists
  298. | |
  299. | +-Logoff<NodeNum>.script
  300. |
  301. +-Mail
  302. | |
  303. | +-<Mail files and dirs>          See the mail system door docs for details
  304. |
  305. +-LostFiles
  306. | |
  307. | +-<Lost files go here>           If a file could not be moved etc it may
  308. |                                  be found in here.  Check logs for matching
  309. |                                  filenames to find out why it is in here.
  310. +-Logs
  311. | |
  312. | +-Error.log                      Check this file for errors ever so often.
  313. | |
  314. | +-<other log files>              Other log files created by doors etc.
  315. |
  316. +-Startup
  317.   |
  318.   +-<programs>                     Like WBStartup but for HBBS!
  319.                                    (not implemented as of 31/July/1997) *C*
  320.  
  321.   Uploaded files are not stored in the HBBS: directory structure as the sysop
  322.   may have other devices that may be setup in a particular way,  below is
  323.   how we recommend you organize your file direcotories as it is a more
  324.   structured way of doing it.
  325.  
  326.   Files:
  327.   |
  328.   +-<ConfName>
  329.     |
  330.     +-Private
  331.     |
  332.     +-BadFiles
  333.     |
  334.     +-Files
  335.  
  336.  
  337. @EndNode
  338.  
  339. @Node Conferences "Conferences"
  340.  
  341.   HBBS:Conferences
  342.   ================
  343.  
  344.   The HBBS:Conferences directory holds all the conference subdirectories.
  345.  
  346.   A Conference is the /X and HBBS term for FILE AREA! (Just in case you didn't
  347.   already know)
  348.  
  349.   BUT Conferences can have their own mail as well as files or just one or
  350.   the other. (by settings different access levels or command settings)
  351.  
  352.   So say you are running a normal warez bbs, you'd probably want the following
  353.   conferences
  354.  
  355.   NewUsers
  356.   Amiga Warez
  357.   PC Warez
  358.   Console Warez
  359.   CD-ROM!
  360.   Group Members
  361.   Sysop Area
  362.   Requests
  363.   BBS Adds
  364.   Test Conference
  365.  
  366.   Most of those conferences would want to have to have files and messages.  But
  367.   you could also want a Help conference or Game Tips or suggestions conference,
  368.   these conferences might not require files but would require mail.
  369.  
  370. @EndNode
  371.  
  372. @Node NodeX "Node<NodeNum>"
  373.  
  374.   HBBS:Nodes/Node<NodeNum>
  375.   ========================
  376.  
  377.   For each node on your system you should create a directory called Node<NodeNum>
  378.   where <NodeNum> is replaced by the node number.  This of course is the default
  379.   and STRONGLY recommended settings.  If you like you may change the location
  380.   of the node directory by changing the option @{"NodeLocation_XX" link HBBS:Docs/Configuration/NodeList.guide/NodeLocation_XX} in the file
  381.   HBBS:Nodes/NodeList
  382.  
  383.   The node directory contains a few other files which are used to configure
  384.   the node, there is also a screens directory for storing node specefic
  385.   screens.  Also there is a commands directory so that you can configure the
  386.   bbs so that some commands can only be run from a certain node.
  387.   Then there's a access directory,  this is so you can set your bbs up so that
  388.   users don't or do have specific access rights for each node.
  389.  
  390. @EndNode
  391.  
  392. @Node WorkDir "Work"
  393.  
  394.   HBBS:Nodes/Node<NodeNum>/Work
  395.   =============================
  396.  
  397.   A directory called "Work" MUST be created in each Node directory you have,
  398.   the bbs stores temporary files in this directory.  Any files in this directory
  399.   are DELETED when the node is reset.
  400.  
  401. @EndNode
  402.  
  403. @Node PlaypenDir "Playpen"
  404.  
  405.   HBBS:Nodes/Node<NodeNum>/PlayPen
  406.   ================================
  407.  
  408.   The location can be changed via @{"NodeLocal" link HBBS:Docs/Configuration/NodeLocal.guide/MAIN}
  409.  
  410.   Uploads are placed in the directory while a user is transferring
  411.  
  412.   If files are found in this directory when a node is restarted (or after a
  413.   system reboot/crash) then the last caller is found, the files are then
  414.   checked (for FileID, Corruption, Duplicate..) and if all is ok they are
  415.   moved into the current conferences upload directory and are added to the
  416.   filelist.
  417.  
  418.   If they have no description they will be moved into the current conference's
  419.   LostFiles direcotory and the FileLists/LostList will be updated with the
  420.   users name, account number and filename.
  421.  
  422. @EndNode
  423.  
  424. @Node ACSUsersDir "Levels"
  425.  
  426.   Users
  427.   =====
  428.  
  429.     This directory MUST be present, but you don't need to have any files
  430.     in it.
  431.  
  432.     in here you should store files with the same name as a users handle, then
  433.     when the access settings are loaded for the current online user, the bbs
  434.     checks to see if there is a file in here with the same name as the users
  435.     handle then the normal access settings are overridden with the settings
  436.     in the files in here!
  437.  
  438.     e.g. say all your users had access to internet mail, but one user was
  439.     abusing it, you could create a file with the same name as the user's handle
  440.     then set the option AllowInternetMail=FALSE in the file.
  441.  
  442. @EndNode
  443.  
  444. @Node ConfigDef "Config File Definition"
  445.  
  446.   Config File Definition
  447.   ======================
  448.  
  449.   Rules
  450.   =====
  451.  
  452.     Please Adhere to the following rules when creating/modifiying your config
  453.     files.
  454.  
  455.     * You may use YES/NO, TRUE/FALSE or ON/OFF for boolean options.
  456.  
  457.     * /'s will be added to paths if required, all paths MUST be have a volume
  458.       name or assign name in them. e.g. HBBS:Screens/ is ok, but Screens isn't
  459.  
  460.     * Space's are NOT permitted in filenames.
  461.  
  462.     * ;'s are used for comment lines, they may be after an option or on
  463.       seperate lines, note: comments are not allowed in some config files
  464.       as ;'s are use in some ANSI escape sequences.  BBSColours.CFG is one
  465.       such file.
  466.  
  467.     * Blank lines are allowed (they aid readability and structure)
  468.  
  469.     * All optionnames MUST start on the first character of the line
  470.  
  471.     * Options take the following format:
  472.  
  473.       Optionname[_XX]=<Option Parameter> ; <comments>
  474.  
  475.       Here's a few examples
  476.  
  477.       BBSName=Utopia!
  478.       BBSGroup_1=Tension
  479.       BBSGroup_2=LSD
  480.       Drives=4
  481.       NodeLog=ON
  482.       NoFreeSpaceScr=HBBS:Scripts/NoFreeSpace.script
  483.  
  484.  
  485.   Notes
  486.   =====
  487.  
  488.     Some options may require more than one setting or a list of settings.
  489.  
  490.     Option parameter types are dependant on the option and the data it
  491.     requires.  Here is a list of some option types that used.
  492.  
  493.     Type         Parameters   Example(s)    Notes
  494.     ============ ============ ============= ==================================      *C* add more
  495.     <String>     A string     Handle >      Spaces are allowed
  496.  
  497.     <Path>       A Path       HBBS:         /'s will be added to the end if
  498.                               HBBS:Screens  they are missed off.
  499.  
  500.     <File>       A Filename   T:Temp.TMP    Always specify full path as well
  501.                                             as the filename
  502.  
  503.     <Boolean>    YES,NO       YES           You can use any of the 6 params
  504.                  TRUE,FALSE   ON            to turn an option on or off.
  505.                  ON,OFF       TRUE
  506.  
  507.     <Numeric>    A Number     123456        Don't use numbers over 10 digits.
  508.  
  509.  
  510. @EndNode
  511.  
  512.  
  513.  
  514.  
  515.